API Documentation
Public Member Functions | List of all members
nkWinUi::InputDescriptor Class Referencefinal

Describes an input event. More...

Public Member Functions

 InputDescriptor (const KeyEventData &keyEvent)
 
 InputDescriptor (const ClickEventData &clickEvent)
 
 InputDescriptor (const MouseMoveEventData &mouseMoveEvent)
 
 InputDescriptor (const WheelEventData &wheelEvent)
 
 ~InputDescriptor ()
 
EVENT_TYPE getType () const
 
const KeyEventDatagetKeyEvent () const
 
const ClickEventDatagetClickEvent () const
 
const MouseMoveEventDatagetMouseMoveEvent () const
 
const WheelEventDatagetWheelEvent () const
 

Detailed Description

Describes an input event.

This class is used to describe simulated events within components. See Component::simulateEvent().

Constructor & Destructor Documentation

◆ InputDescriptor() [1/4]

nkWinUi::InputDescriptor::InputDescriptor ( const KeyEventData keyEvent)

Key event constructor.

Parameters
keyEventThe key event to use as an input.

◆ InputDescriptor() [2/4]

nkWinUi::InputDescriptor::InputDescriptor ( const ClickEventData clickEvent)

Click event constructor.

Parameters
clickEventThe click event to use as an input.

◆ InputDescriptor() [3/4]

nkWinUi::InputDescriptor::InputDescriptor ( const MouseMoveEventData mouseMoveEvent)

Mouse move event constructor.

Parameters
mouseMoveEventThe mouse move event to use as an input.

◆ InputDescriptor() [4/4]

nkWinUi::InputDescriptor::InputDescriptor ( const WheelEventData wheelEvent)

Mouse wheel event constructor.

Parameters
wheelEventThe mouse weel event to use as an input.

◆ ~InputDescriptor()

nkWinUi::InputDescriptor::~InputDescriptor ( )

Destructor.

Member Function Documentation

◆ getType()

EVENT_TYPE nkWinUi::InputDescriptor::getType ( ) const
Returns
The associated event type.

◆ getKeyEvent()

const KeyEventData& nkWinUi::InputDescriptor::getKeyEvent ( ) const
Returns
The associated key event data.

◆ getClickEvent()

const ClickEventData& nkWinUi::InputDescriptor::getClickEvent ( ) const
Returns
The associated click event data.

◆ getMouseMoveEvent()

const MouseMoveEventData& nkWinUi::InputDescriptor::getMouseMoveEvent ( ) const
Returns
The associated mouse move event data.

◆ getWheelEvent()

const WheelEventData& nkWinUi::InputDescriptor::getWheelEvent ( ) const
Returns
The associated mouse wheel event data.

The documentation for this class was generated from the following file: